<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <meta content="width=device-width, initial-scale=1.0" name="viewport">
    <meta content="smart-doc" name="generator">
    <title>service-auth</title>
    <link href="font.css" rel="stylesheet">
    <link href="AllInOne.css?v=1665239542406" rel="stylesheet"/>
    <style>.literalblock pre, .listingblock pre:not(.highlight), .listingblock pre[class="highlight"], .listingblock pre[class^="highlight "], .listingblock pre.CodeRay, .listingblock pre.prettyprint {
        background: #f7f7f8
    }

    .hljs {
        padding: 0
    }</style>
    <script src="highlight.min.js"></script>
    <script src="jquery.min.js"></script>
</head>
<body class="book toc2 toc-left">
<div id="header"><h1>service-auth</h1>
    <div class="toc2" id="toc">
        <div id="book-search-input"><input id="search" placeholder="Type to search" type="text"></div>
        <div id="toctitle"><span>API Reference</span></div>
        <ul class="sectlevel1" id="accordion">            <li class="open"><a class="dd" href="#_认证控制器">1.认证控制器</a>
                <ul class="sectlevel2">
                    <li><a
                            href="#_1_1_1_登录接口">1.1.登录接口</a>
                    </li>

                    <li><a
                            href="#_1_1_2_登录接口">1.2.登录接口</a>
                    </li>

                    <li><a
                            href="#_1_1_3_刷新 token 接口">1.3.刷新 token 接口</a>
                    </li>

                    <li><a
                            href="#_1_1_4_退出登录">1.4.退出登录</a>
                    </li>

                    <li><a
                            href="#_1_1_5_获取公钥此接口需要原样返回, 响应不能包装">1.5.获取公钥此接口需要原样返回, 响应不能包装</a>
                    </li>
                </ul>
            </li>
        </ul>
    </div>
</div>
<div id="content">
    <div id="preamble">
        <div class="sectionbody">
            <table class="tableblock frame-all grid-all spread">
                <colgroup>
                    <col style="width: 20%;">
                    <col style="width: 20%;">
                    <col style="width: 20%;">
                    <col style="width: 20%;">
                    <col style="width: 20%;">
                </colgroup>
                <thead>
                <tr>
                    <th class="tableblock halign-left valign-top">Version</th>
                    <th class="tableblock halign-left valign-top">Update Time</th>
                    <th class="tableblock halign-left valign-top">Status</th>
                    <th class="tableblock halign-left valign-top">Author</th>
                    <th class="tableblock halign-left valign-top">Description</th>
                </tr>
                </thead>
                <tbody>
                <tr>
                    <td class="tableblock halign-left valign-top"><p class="tableblock">v2022-10-08 22:32:22</p></td>
                    <td class="tableblock halign-left valign-top"><p class="tableblock">2022-10-08 22:32:22</p>
                    </td>
                    <td class="tableblock halign-left valign-top"><p class="tableblock">auto</p></td>
                    <td class="tableblock halign-left valign-top"><p class="tableblock">@mazaiting</p></td>
                    <td class="tableblock halign-left valign-top"><p class="tableblock">Created by smart-doc</p></td>
                </tr>
                </tbody>
            </table>
        </div>
    </div>
    
    <div class="sect1"><h2 id="_认证控制器"><a class="anchor" href="#_认证控制器"></a><a class="link"
                                                                                           href="#_认证控制器">1.认证控制器</a>
    </h2>
        <div class="sectionbody">
            <div class="sect2" id="2ad8271f823cf13aae331866bcc81442"><h3 id="_1_1_1_登录接口"><a
                    class="anchor" href="#_1_1_1_登录接口"></a><a class="link"
                                                                                        href="#_1_1_1_登录接口">1.1.登录接口</a>
            </h3>
                <div class="paragraph" data-download="false" data-page="" data-url="/auth/v1/oauth/login"
                     id="2ad8271f823cf13aae331866bcc81442-url"><p><strong>URL:</strong><a class="bare"
                                                                         href="/auth/v1/oauth/login">/auth/v1/oauth/login</a></p>
                </div>
                <div class="paragraph" data-method="POST" id="2ad8271f823cf13aae331866bcc81442-method"><p><strong>Type:</strong>POST
                </p></div>
                <div class="paragraph" data-content-type="application/x-www-form-urlencoded;charset=utf-8" id="2ad8271f823cf13aae331866bcc81442-content-type"><p>
                    <strong>Content-Type:</strong>application/x-www-form-urlencoded;charset=utf-8</p></div>
                <div class="paragraph"><p><strong>Description:</strong>登录接口</p></div>
                <div class="paragraph"><p><strong>Query-parameters:</strong></p></div>
                <table class="tableblock frame-all grid-all spread">
                    <colgroup>
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                    </colgroup>
                    <thead>
                    <tr>
                        <th class="tableblock halign-left valign-top">Parameter</th>
                        <th class="tableblock halign-left valign-top">Type</th>
                        <th class="tableblock halign-left valign-top">Description</th>
                        <th class="tableblock halign-left valign-top">Required</th>
                        <th class="tableblock halign-left valign-top">Since</th>
                    </tr>
                    </thead>
                    <tbody>
                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">username</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            用户名</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">password</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            密码</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">uuid</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            验证码需要的 UUID - 唯一标识验证码<br>grant_type = captcha 时不为空</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">code</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            图形验证码值<br>grant_type = captcha/sms_code 时不为空</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">mobile</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            手机号码<br>grant_type = sms_code 时不为空</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>
                    </tbody>
                </table>
                <div class="paragraph"><p><strong>Request-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="bash">curl -X POST -i /auth/v1/oauth/login</code></pre>
                    </div>
                </div>
                <div class="paragraph"><p><strong>Response-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="json">{}</code></pre>
                    </div>
                </div>
            </div>

            <div class="sect2" id="8b6b033c3ad5a18137b564bcb4a89c74"><h3 id="_1_1_2_登录接口"><a
                    class="anchor" href="#_1_1_2_登录接口"></a><a class="link"
                                                                                        href="#_1_1_2_登录接口">1.2.登录接口</a>
            </h3>
                <div class="paragraph" data-download="false" data-page="" data-url="/auth/v1/oauth/wechatLogin"
                     id="8b6b033c3ad5a18137b564bcb4a89c74-url"><p><strong>URL:</strong><a class="bare"
                                                                         href="/auth/v1/oauth/wechatLogin">/auth/v1/oauth/wechatLogin</a></p>
                </div>
                <div class="paragraph" data-method="POST" id="8b6b033c3ad5a18137b564bcb4a89c74-method"><p><strong>Type:</strong>POST
                </p></div>
                <div class="paragraph" data-content-type="application/x-www-form-urlencoded;charset=utf-8" id="8b6b033c3ad5a18137b564bcb4a89c74-content-type"><p>
                    <strong>Content-Type:</strong>application/x-www-form-urlencoded;charset=utf-8</p></div>
                <div class="paragraph"><p><strong>Description:</strong>登录接口</p></div>
                <div class="paragraph"><p><strong>Query-parameters:</strong></p></div>
                <table class="tableblock frame-all grid-all spread">
                    <colgroup>
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                        <col style="width: 20%;">
                    </colgroup>
                    <thead>
                    <tr>
                        <th class="tableblock halign-left valign-top">Parameter</th>
                        <th class="tableblock halign-left valign-top">Type</th>
                        <th class="tableblock halign-left valign-top">Description</th>
                        <th class="tableblock halign-left valign-top">Required</th>
                        <th class="tableblock halign-left valign-top">Since</th>
                    </tr>
                    </thead>
                    <tbody>
                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">code</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            js_code</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">encryptedData</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            加密数据</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>

                    <tr>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">iv</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">string</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">
                            IV key</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">false</p></td>
                        <td class="tableblock halign-left valign-top"><p class="tableblock">-</p></td>
                    </tr>
                    </tbody>
                </table>
                <div class="paragraph"><p><strong>Request-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="bash">curl -X POST -i /auth/v1/oauth/wechatLogin</code></pre>
                    </div>
                </div>
                <div class="paragraph"><p><strong>Response-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="json">{}</code></pre>
                    </div>
                </div>
            </div>

            <div class="sect2" id="592fcdb525d2e23bbd1386e5641679a9"><h3 id="_1_1_3_刷新 token 接口"><a
                    class="anchor" href="#_1_1_3_刷新 token 接口"></a><a class="link"
                                                                                        href="#_1_1_3_刷新 token 接口">1.3.刷新 token 接口</a>
            </h3>
                <div class="paragraph" data-download="false" data-page="" data-url="/auth/v1/oauth/refresh"
                     id="592fcdb525d2e23bbd1386e5641679a9-url"><p><strong>URL:</strong><a class="bare"
                                                                         href="/auth/v1/oauth/refresh">/auth/v1/oauth/refresh</a></p>
                </div>
                <div class="paragraph" data-method="POST" id="592fcdb525d2e23bbd1386e5641679a9-method"><p><strong>Type:</strong>POST
                </p></div>
                <div class="paragraph" data-content-type="application/x-www-form-urlencoded;charset=utf-8" id="592fcdb525d2e23bbd1386e5641679a9-content-type"><p>
                    <strong>Content-Type:</strong>application/x-www-form-urlencoded;charset=utf-8</p></div>
                <div class="paragraph"><p><strong>Description:</strong>刷新 token 接口</p></div>
                <div class="paragraph"><p><strong>Request-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="bash">curl -X POST -i /auth/v1/oauth/refresh</code></pre>
                    </div>
                </div>
                <div class="paragraph"><p><strong>Response-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="json">{}</code></pre>
                    </div>
                </div>
            </div>

            <div class="sect2" id="f06a5fd9f3f904ef5ebf9bda3b4764f0"><h3 id="_1_1_4_退出登录"><a
                    class="anchor" href="#_1_1_4_退出登录"></a><a class="link"
                                                                                        href="#_1_1_4_退出登录">1.4.退出登录</a>
            </h3>
                <div class="paragraph" data-download="false" data-page="" data-url="/auth/v1/oauth/logout"
                     id="f06a5fd9f3f904ef5ebf9bda3b4764f0-url"><p><strong>URL:</strong><a class="bare"
                                                                         href="/auth/v1/oauth/logout">/auth/v1/oauth/logout</a></p>
                </div>
                <div class="paragraph" data-method="DELETE" id="f06a5fd9f3f904ef5ebf9bda3b4764f0-method"><p><strong>Type:</strong>DELETE
                </p></div>
                <div class="paragraph" data-content-type="application/x-www-form-urlencoded;charset=utf-8" id="f06a5fd9f3f904ef5ebf9bda3b4764f0-content-type"><p>
                    <strong>Content-Type:</strong>application/x-www-form-urlencoded;charset=utf-8</p></div>
                <div class="paragraph"><p><strong>Description:</strong>退出登录</p></div>
                <div class="paragraph"><p><strong>Request-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="bash">curl -X DELETE -i /auth/v1/oauth/logout</code></pre>
                    </div>
                </div>
                <div class="paragraph"><p><strong>Response-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="json">Return void.</code></pre>
                    </div>
                </div>
            </div>

            <div class="sect2" id="15dc8c732d963fd4b2a27e499ace0be5"><h3 id="_1_1_5_获取公钥此接口需要原样返回, 响应不能包装"><a
                    class="anchor" href="#_1_1_5_获取公钥此接口需要原样返回, 响应不能包装"></a><a class="link"
                                                                                        href="#_1_1_5_获取公钥此接口需要原样返回, 响应不能包装">1.5.获取公钥此接口需要原样返回, 响应不能包装</a>
            </h3>
                <div class="paragraph" data-download="false" data-page="" data-url="/auth/v1/oauth/publicKey"
                     id="15dc8c732d963fd4b2a27e499ace0be5-url"><p><strong>URL:</strong><a class="bare"
                                                                         href="/auth/v1/oauth/publicKey">/auth/v1/oauth/publicKey</a></p>
                </div>
                <div class="paragraph" data-method="GET" id="15dc8c732d963fd4b2a27e499ace0be5-method"><p><strong>Type:</strong>GET
                </p></div>
                <div class="paragraph" data-content-type="application/x-www-form-urlencoded;charset=utf-8" id="15dc8c732d963fd4b2a27e499ace0be5-content-type"><p>
                    <strong>Content-Type:</strong>application/x-www-form-urlencoded;charset=utf-8</p></div>
                <div class="paragraph"><p><strong>Description:</strong>获取公钥
此接口需要原样返回, 响应不能包装</p></div>
                <div class="paragraph"><p><strong>Request-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="bash">curl -X GET -i /auth/v1/oauth/publicKey</code></pre>
                    </div>
                </div>
                <div class="paragraph"><p><strong>Response-example:</strong></p></div>
                <div class="listingblock">
                    <div class="content">
                        <pre><code class="json">string</code></pre>
                    </div>
                </div>
            </div>
        </div>
    </div>
    <footer class="page-footer"><span class="copyright">Generated by smart-doc at 2022-10-08 22:32:22</span><span
            class="footer-modification">Suggestions,contact,support and error reporting on<a
            href="https://gitee.com/smart-doc-team/smart-doc" target="_blank">Gitee</a>or<a
            href="https://github.com/smart-doc-group/smart-doc.git" target="_blank">Github</a></span>
    </footer>
    <div href="javascript:void(0)" id="toTop"><img id="upArrow"
                                                   src=""><span
            id="upText">Top</span></div>
</div>
<script src="search.js?v=1665239542406"></script>
<script>
    $(function(){const Accordion=function(el,multiple){this.el=el||{};this.multiple=multiple||false;const links=this.el.find(".dd");links.on("click",{el:this.el,multiple:this.multiple},this.dropdown)};Accordion.prototype.dropdown=function(e){const $el=e.data.el;const $this=$(this),$next=$this.next();$next.slideToggle();$this.parent().toggleClass("open");if(!e.data.multiple){$el.find(".submenu").not($next).slideUp("20").parent().removeClass("open")}};new Accordion($("#accordion"),false);hljs.highlightAll();$(window).scroll(function(){if($(window).scrollTop()>100){$("#toTop").fadeIn(1500);$("#toTop").hover(function(){$("#upArrow").hide();$("#upText").show()},function(){$("#upArrow").show();$("#upText").hide()})}else{$("#toTop").fadeOut(1500)}});$("#toTop").click(function(){$("body, html").animate({scrollTop:0},1000);return false})});










</script>
</body>
</html>